Sustainable, Extensible Documentation Generation using inlinedocs
نویسندگان
چکیده
The concept of structured, interwoven code and documentation has existed for many years, but existing systems that implement this for the R programming language do not tightly integrate with R code, leading to several drawbacks. This article attempts to address these issues and presents 2 contributions for documentation generation for the R community. First, we propose a new syntax for inline documentation of R code within comments adjacent to the relevant code, which allows for highly readable and maintainable code and documentation. Second, we propose an extensible system for parsing these comments, which allows the syntax to be easily augmented.
منابع مشابه
Producing Instructions
This paper presents an environment that supports the production of instructions, exploiting methodologies and technologies from Human-Computer-Interaction, Natural Language Processing and Software Engineering. In this environment, instructions are automatically generated from task models. The environment includes an interactive tool to build task models, an extensible set of knowledge acquisiti...
متن کاملStatus and Direction of XML in Information Development in IBM
For the past two years, a workgroup inside IBM's User Technology community has been working on creating a XML architecture for the next generation of technical documentation. In this paper we describe the current state of that work, the status of the Darwin Information Typing Architecture, and our directions for XML. We also discuss our guiding principles for our work on XML and our activities ...
متن کاملExtensible Authentication Protocol Method for Global System for Mobile Communications (GSM) Subscriber Identity Modules (EAP-SIM)
Status of This Memo This memo provides information for the Internet community. It does not specify an Internet standard of any kind. Distribution of this memo is unlimited. The EAP-SIM protocol was developed by 3GPP. The documentation of EAP-SIM is provided as information to the Internet community. While the EAP WG has verified that EAP-SIM is compatible with EAP, as defined in RFC 3748, no oth...
متن کاملConnecting Writers and Translators - XML-based Content Management of Product Documentation at Autodesk
For most of its products, Autodesk traditionally follows documentation creation and translation processes similar to those employed by many other software companies. The vast majority of the documentation is created in unstructured Adobe Framemaker, some also in Microsoft Word or directly in HTML. Single-sourcing of online help and printed documentation is typically achieved through complex con...
متن کاملذخیره در منابع من
با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید
عنوان ژورنال:
دوره شماره
صفحات -
تاریخ انتشار 2012